2004年09月14日
川俣晶の縁側ソフトウェア技術雑記 total 3116 count

基本中の基本、ドキュメントには日付を入れましょう

Written By: 川俣 晶連絡先

 とても基本的であり過ぎて、今更そんなことを書くことにどんな意味があるのかも分かりませんが。

 ちょっと気になることがあったので、あえてここで書いてみましょう。

 プログラムを開発してリリースする場合、各バージョンをリリースする日付はしっかりと書き込みましょう。それは、後から様々な目的で活用できる有益な情報です。

 日付を含め、いつ、だれが、何をしたのかを明確にしておくことは文書作成の基本中の基本です。それが出来ていないと、一人前扱いされず、使えない奴、というレッテルを貼られる可能性があります。これは本来なら学校で理屈抜きに叩き込んでおくべきレベルの話だと思いますが、残念ながら、そのような教育はきちんと行われておらず、意識的に注意する価値があります。

という話をなぜ書いたのかと言えば §

 という話をなぜ書いたのかと言えば、ちょっと理由があってApache HTTP Serverの各バージョンがいつリリースされているか確認したいと思って調べたところ、それが分からなかったからです。

 一応、以下のようなドキュメントはありました。

ChangeLog for 2.0

 これに、バージョン間の変更履歴が書かれています。

 しかし、古いリリースにはきちんと日付が入っていますが、最近のリリースには日付が入っていません。

 もしかしたら、どこかに、各バージョンのリリース日付が分かる文書があるのかも知れませんが、ざっと見た限りでは見あたりませんでした。

 ちょっとこれはお粗末な感じがします。

 世界で一番使われているHTTPサーバとしてトップクラスのオープンソースソフトウェアであるはずですが、そのソフトウェアですら基本ができていないとは。ちょっと、オープンソースを買いかぶっていたのかな、とちょっと反省。